<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PolkitActionDescription</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="polkit Reference Manual">
<link rel="up" href="ref-api.html" title="Part III. Client API Reference">
<link rel="prev" href="PolkitError.html" title="PolkitError">
<link rel="next" href="PolkitTemporaryAuthorization.html" title="PolkitTemporaryAuthorization">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="PolkitError.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ref-api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">polkit Reference Manual</th>
<td><a accesskey="n" href="PolkitTemporaryAuthorization.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#PolkitActionDescription.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#PolkitActionDescription.description" class="shortcut">Description</a>
                   | 
                  <a href="#PolkitActionDescription.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="PolkitActionDescription"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="PolkitActionDescription.top_of_page"></a>PolkitActionDescription</span></h2>
<p>PolkitActionDescription — Description of Actions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="PolkitActionDescription.synopsis"></a><h2>Synopsis</h2>
<a name="PolkitImplicitAuthorization"></a><pre class="synopsis">                    <a class="link" href="PolkitActionDescription.html#PolkitActionDescription-struct" title="PolkitActionDescription">PolkitActionDescription</a>;
enum                <a class="link" href="PolkitActionDescription.html#PolkitImplicitAuthorization-enum" title="enum PolkitImplicitAuthorization">PolkitImplicitAuthorization</a>;
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="PolkitActionDescription.html#polkit-action-description-get-action-id" title="polkit_action_description_get_action_id ()">polkit_action_description_get_action_id</a>
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="PolkitActionDescription.html#polkit-action-description-get-description" title="polkit_action_description_get_description ()">polkit_action_description_get_description</a>
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="PolkitActionDescription.html#polkit-action-description-get-message" title="polkit_action_description_get_message ()">polkit_action_description_get_message</a>
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="PolkitActionDescription.html#polkit-action-description-get-vendor-name" title="polkit_action_description_get_vendor_name ()">polkit_action_description_get_vendor_name</a>
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="PolkitActionDescription.html#polkit-action-description-get-vendor-url" title="polkit_action_description_get_vendor_url ()">polkit_action_description_get_vendor_url</a>
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="PolkitActionDescription.html#polkit-action-description-get-icon-name" title="polkit_action_description_get_icon_name ()">polkit_action_description_get_icon_name</a>
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);
<a class="link" href="PolkitActionDescription.html#PolkitImplicitAuthorization"><span class="returnvalue">PolkitImplicitAuthorization</span></a> <a class="link" href="PolkitActionDescription.html#polkit-action-description-get-implicit-any" title="polkit_action_description_get_implicit_any ()">polkit_action_description_get_implicit_any</a>
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);
<a class="link" href="PolkitActionDescription.html#PolkitImplicitAuthorization"><span class="returnvalue">PolkitImplicitAuthorization</span></a> <a class="link" href="PolkitActionDescription.html#polkit-action-description-get-implicit-inactive" title="polkit_action_description_get_implicit_inactive ()">polkit_action_description_get_implicit_inactive</a>
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);
<a class="link" href="PolkitActionDescription.html#PolkitImplicitAuthorization"><span class="returnvalue">PolkitImplicitAuthorization</span></a> <a class="link" href="PolkitActionDescription.html#polkit-action-description-get-implicit-active" title="polkit_action_description_get_implicit_active ()">polkit_action_description_get_implicit_active</a>
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="PolkitActionDescription.html#polkit-action-description-get-annotation" title="polkit_action_description_get_annotation ()">polkit_action_description_get_annotation</a>
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="PolkitActionDescription.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----PolkitActionDescription
</pre>
<pre class="synopsis">
  GEnum
   +----PolkitImplicitAuthorization
</pre>
</div>
<div class="refsect1">
<a name="PolkitActionDescription.description"></a><h2>Description</h2>
<p>
Object used to encapsulate a registered action.
</p>
</div>
<div class="refsect1">
<a name="PolkitActionDescription.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="PolkitActionDescription-struct"></a><h3>PolkitActionDescription</h3>
<pre class="programlisting">typedef struct _PolkitActionDescription PolkitActionDescription;</pre>
<p>
The <a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> struct should not be accessed directly.
</p>
</div>
<hr>
<div class="refsect2">
<a name="PolkitImplicitAuthorization-enum"></a><h3>enum PolkitImplicitAuthorization</h3>
<pre class="programlisting">typedef enum {
  POLKIT_IMPLICIT_AUTHORIZATION_UNKNOWN = -1,
  POLKIT_IMPLICIT_AUTHORIZATION_NOT_AUTHORIZED = 0,
  POLKIT_IMPLICIT_AUTHORIZATION_AUTHENTICATION_REQUIRED = 1,
  POLKIT_IMPLICIT_AUTHORIZATION_ADMINISTRATOR_AUTHENTICATION_REQUIRED = 2,
  POLKIT_IMPLICIT_AUTHORIZATION_AUTHENTICATION_REQUIRED_RETAINED = 3,
  POLKIT_IMPLICIT_AUTHORIZATION_ADMINISTRATOR_AUTHENTICATION_REQUIRED_RETAINED = 4,
  POLKIT_IMPLICIT_AUTHORIZATION_AUTHORIZED = 5,
} PolkitImplicitAuthorization;
</pre>
<p>
Possible implicit authorizations.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="POLKIT-IMPLICIT-AUTHORIZATION-UNKNOWN:CAPS"></a><span class="term"><code class="literal">POLKIT_IMPLICIT_AUTHORIZATION_UNKNOWN</code></span></p></td>
<td>Unknown whether the subject is authorized, never returned in any public API.
</td>
</tr>
<tr>
<td><p><a name="POLKIT-IMPLICIT-AUTHORIZATION-NOT-AUTHORIZED:CAPS"></a><span class="term"><code class="literal">POLKIT_IMPLICIT_AUTHORIZATION_NOT_AUTHORIZED</code></span></p></td>
<td>Subject is not authorized.
</td>
</tr>
<tr>
<td><p><a name="POLKIT-IMPLICIT-AUTHORIZATION-AUTHENTICATION-REQUIRED:CAPS"></a><span class="term"><code class="literal">POLKIT_IMPLICIT_AUTHORIZATION_AUTHENTICATION_REQUIRED</code></span></p></td>
<td>Authentication is required.
</td>
</tr>
<tr>
<td><p><a name="POLKIT-IMPLICIT-AUTHORIZATION-ADMINISTRATOR-AUTHENTICATION-REQUIRED:CAPS"></a><span class="term"><code class="literal">POLKIT_IMPLICIT_AUTHORIZATION_ADMINISTRATOR_AUTHENTICATION_REQUIRED</code></span></p></td>
<td>Authentication as an administrator is required.
</td>
</tr>
<tr>
<td><p><a name="POLKIT-IMPLICIT-AUTHORIZATION-AUTHENTICATION-REQUIRED-RETAINED:CAPS"></a><span class="term"><code class="literal">POLKIT_IMPLICIT_AUTHORIZATION_AUTHENTICATION_REQUIRED_RETAINED</code></span></p></td>
<td>Authentication is required. If the authorization is obtained, it is retained.
</td>
</tr>
<tr>
<td><p><a name="POLKIT-IMPLICIT-AUTHORIZATION-ADMINISTRATOR-AUTHENTICATION-REQUIRED-RETAINED:CAPS"></a><span class="term"><code class="literal">POLKIT_IMPLICIT_AUTHORIZATION_ADMINISTRATOR_AUTHENTICATION_REQUIRED_RETAINED</code></span></p></td>
<td>Authentication as an administrator is required. If the authorization is obtained, it is retained.
</td>
</tr>
<tr>
<td><p><a name="POLKIT-IMPLICIT-AUTHORIZATION-AUTHORIZED:CAPS"></a><span class="term"><code class="literal">POLKIT_IMPLICIT_AUTHORIZATION_AUTHORIZED</code></span></p></td>
<td>The subject is authorized
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-action-description-get-action-id"></a><h3>polkit_action_description_get_action_id ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       polkit_action_description_get_action_id
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);</pre>
<p>
Gets the action id for <em class="parameter"><code>action_description</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_description</code></em> :</span></p></td>
<td>A <a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string owned by <em class="parameter"><code>action_description</code></em>. Do not free.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-action-description-get-description"></a><h3>polkit_action_description_get_description ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       polkit_action_description_get_description
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);</pre>
<p>
Gets the description used for <em class="parameter"><code>action_description</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_description</code></em> :</span></p></td>
<td>A <a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string owned by <em class="parameter"><code>action_description</code></em>. Do not free.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-action-description-get-message"></a><h3>polkit_action_description_get_message ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       polkit_action_description_get_message
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);</pre>
<p>
Gets the message used for <em class="parameter"><code>action_description</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_description</code></em> :</span></p></td>
<td>A <a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string owned by <em class="parameter"><code>action_description</code></em>. Do not free.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-action-description-get-vendor-name"></a><h3>polkit_action_description_get_vendor_name ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       polkit_action_description_get_vendor_name
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);</pre>
<p>
Gets the vendor name for <em class="parameter"><code>action_description</code></em>, if any.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_description</code></em> :</span></p></td>
<td>A <a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string owned by <em class="parameter"><code>action_description</code></em>. Do not free.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-action-description-get-vendor-url"></a><h3>polkit_action_description_get_vendor_url ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       polkit_action_description_get_vendor_url
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);</pre>
<p>
Gets the vendor URL for <em class="parameter"><code>action_description</code></em>, if any.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_description</code></em> :</span></p></td>
<td>A <a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string owned by <em class="parameter"><code>action_description</code></em>. Do not free.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-action-description-get-icon-name"></a><h3>polkit_action_description_get_icon_name ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       polkit_action_description_get_icon_name
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);</pre>
<p>
Gets the icon name for <em class="parameter"><code>action_description</code></em>, if any.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_description</code></em> :</span></p></td>
<td>A <a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string owned by <em class="parameter"><code>action_description</code></em>. Do not free.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-action-description-get-implicit-any"></a><h3>polkit_action_description_get_implicit_any ()</h3>
<pre class="programlisting"><a class="link" href="PolkitActionDescription.html#PolkitImplicitAuthorization"><span class="returnvalue">PolkitImplicitAuthorization</span></a> polkit_action_description_get_implicit_any
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);</pre>
<p>
Gets the implicit authorization for <em class="parameter"><code>action_description</code></em> used for
any subject.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_description</code></em> :</span></p></td>
<td>A <a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A value from the <a class="link" href="PolkitActionDescription.html#PolkitImplicitAuthorization"><span class="type">PolkitImplicitAuthorization</span></a> enumeration.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-action-description-get-implicit-inactive"></a><h3>polkit_action_description_get_implicit_inactive ()</h3>
<pre class="programlisting"><a class="link" href="PolkitActionDescription.html#PolkitImplicitAuthorization"><span class="returnvalue">PolkitImplicitAuthorization</span></a> polkit_action_description_get_implicit_inactive
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);</pre>
<p>
Gets the implicit authorization for <em class="parameter"><code>action_description</code></em> used for
subjects in inactive sessions on a local console.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_description</code></em> :</span></p></td>
<td>A <a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A value from the <a class="link" href="PolkitActionDescription.html#PolkitImplicitAuthorization"><span class="type">PolkitImplicitAuthorization</span></a> enumeration.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-action-description-get-implicit-active"></a><h3>polkit_action_description_get_implicit_active ()</h3>
<pre class="programlisting"><a class="link" href="PolkitActionDescription.html#PolkitImplicitAuthorization"><span class="returnvalue">PolkitImplicitAuthorization</span></a> polkit_action_description_get_implicit_active
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>);</pre>
<p>
Gets the implicit authorization for <em class="parameter"><code>action_description</code></em> used for
subjects in active sessions on a local console.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_description</code></em> :</span></p></td>
<td>A <a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A value from the <a class="link" href="PolkitActionDescription.html#PolkitImplicitAuthorization"><span class="type">PolkitImplicitAuthorization</span></a> enumeration.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="polkit-action-description-get-annotation"></a><h3>polkit_action_description_get_annotation ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       polkit_action_description_get_annotation
                                                        (<em class="parameter"><code><a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a> *action_description</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>);</pre>
<p>
Get the value of the annotation with <em class="parameter"><code>key</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>action_description</code></em> :</span></p></td>
<td>A <a class="link" href="PolkitActionDescription.html" title="PolkitActionDescription"><span class="type">PolkitActionDescription</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>An annotation key.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if there is no annoation with <em class="parameter"><code>key</code></em>,
otherwise the annotation value owned by <em class="parameter"><code>action_description</code></em>. Do not
free. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>